feat(): experimental support for typedoc generation #17377
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Run
npm run typedoc
to generate docs intypedoc-docs
dir.I thought I'd take a few mins and set this up. It was mostly straightforward, except:
.js
entry points are assumed to be compiled, and thus require asourceMappingUrl
reference. IMO this is probably a bug in TypeDocsourceMappingUrl
must reference an external sourcemap file; not an inline source map. If it's an inline source map, the system tries tofs.open
a large data-url.@babel/cli
does. So I needed to change those.tsconfig.json
to start with "the biggest one first"I didn't modify any types or docstrings anywhere.
The intent here is to show a proof-of-concept.